home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / reset tools / shutdown / shutdown_v10.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  6KB  |  149 lines
  1. @database ShutDown_help
  2. ShutDown v1.0 - (C) 1994 Tom De Voeght.
  3. Please use AmigaGuide or MultiView to read this document.
  4. @master ShutDown.guide
  5. @node main "ShutDown Doc"
  6.                               @{b}ShutDown v1.0
  7.                           (C) 1994 Tom De Voeght.@{ub}
  8.                   _/          _/  _/_/_/_/    _/_/_/    _/_/_/
  9.                  _/          _/  _/        _/        _/
  10.        A        _/    _/    _/  _/_/_/    _/        _/          Production
  11.                  _/  _/  _/    _/        _/        _/
  12.                   _/  _/      _/_/_/_/    _/_/_/    _/_/_/
  13. This is the documentation of an advanced ShutDown command for the Amiga.
  14.                           @{"     Introduction      " link intro}
  15.                           @{"  Execution & Startup  " link execution}
  16.                           @{"     Installation      " link install}
  17.                           @{"        About          " link about}
  18.                           @{"   Acknowledgements    " link ack}
  19.                           @{"       Author          " link author}
  20.                           @{"       History         " link history}
  21.                           @{"        To Do          " link todo}
  22. @endnode
  23. @node intro "Introduction"
  24. Introduction :
  25. ~~~~~~~~~~~~~~
  26. I once came across a command named 'reset' ; it looked good, and it
  27. was rather small, so I was really happy with it, but then ...
  28. As we all know resetting your Amiga can be dangerous, especially when
  29. there is/was any disk-activity at the time of your reset. I guess we 
  30. all experienced that many times ; disk not validated anymore, and 
  31. sometimes loss of data.
  32. Well, here is ShutDown. This new command will prompt you with a @{"ReqTools" link reqtools}
  33. requester before it resets the computer, securing your data, because all 
  34. tasks can and will be finished. A real ShutDown as on UN*X systems.
  35. But there is more ... For those who have Static Memory (StatRAM device),
  36. ShutDown will call the 'killsd0' command imbedded in the STATRAM-package
  37. and enable you to perform a total ShutDown, including the recoverable 
  38. RAM. There is an acknowledgement inside this procedure, so you cannot 
  39. go wrong here. Each function of ShutDown is hereby protected ... :-)
  40. In other words, it might be a bit large (1.5 Kb), but its features are 
  41. worth it, and I'm sure you'll find this command rather useful ...
  42. There's more to come :  @{" To Do " link todo}
  43. No doubt these features will come soon, although I started coding this
  44. Software just to try out some ReqTools-possibilities. It worked just
  45. great, and therefor I decided to share the command with the rest of
  46. the world ; who knows who my use it ? :-)
  47. @endnode
  48. @node execution "Execution"
  49. Execution :
  50. ~~~~~~~~~~~
  51. For v1.0 execution is rather easy : just double click the icon or 
  52. type 'ShutDown' in a shell-window. From there onwards you'll be guided
  53. through the command thanks to the excellent  @{" ReqTools " link reqtools} interface.
  54. As I already said, for the moment no tooltypes or command line options
  55. present, but this will soon be changed, if I have enough time to add
  56. the missing code (see @{" To Do " link todo}).
  57. @endnode
  58. @node install "Installation"
  59. Installation :
  60. ~~~~~~~~~~~~~~
  61. This is the easy part ...
  62. Installing ShutDown isn't very tough ; you just need to copy it somewhere
  63. in your path, and that's all there is to be done. Simple, eh ?
  64.  copy ShutDown C:
  65. Will copy the ShutDown program to your C: assign, which is always in the
  66. path, and will always give you access to the ShutDown command.
  67. @endnode
  68. @node about "About"
  69. Distribution :
  70. ~~~~~~~~~~~~~~
  71. ShutDown is freely distributable software, but it's also
  72. Copyright (C) Tom De Voeght. You can freely copy/spread it 
  73. as long as you don't make any profit doing it and that 
  74. the  original archive  remains intact. 
  75. The above is also known as FreeWare.
  76. IMPORTANT !!!!
  77. ~~~~~~~~~~~~~~
  78. You will need a written  permission from the author if you  
  79. want to include ShutDown in ANY software package, either 
  80. commercial or freely distributable packages.
  81. Disclaimer :
  82. ~~~~~~~~~~~~
  83. The Author can't be held  responsible for any damage this
  84. software may cause, directly or indirectly, on the system
  85. it is run. You're using it at your own risk.
  86. @endnode
  87. @node ack "Acknowledgements"
  88. Acknowledgements :
  89. ~~~~~~~~~~~~~~~~~~
  90. The @{" author " link author} would like to thank the following people for their 
  91. support :  (alphabetical order)
  92.   - Arun Kumar          (thanks for learning me my first steps in C)
  93.   - Nico Fran
  94. ois       (Great @{"ReqTools" link reqtools} & other stuff)
  95.   - Rafael D'Halleweyn  (Tips & Suggestions. Thanx, Raf !)
  96.   - The Amiga for being such a great pal ... I love it ... :-)
  97. ShutDown was developed on an antique A-500 with 1 Mb CHIP & 2 Mb FAST.
  98. AmigaOS 2.05 & 1.2 were both used for testing this program.
  99. @endnode
  100. @node author "Author"
  101. Author :
  102. ~~~~~~~~
  103. ShutDown v1.0 is 
  104.  Copyright 1994 by Tom De Voeght.
  105. See @{" About " link about} for further details on distribution etc.
  106. The author can be reached for all bug-reports, suggestions, etc. :
  107. (flames will be politely discarded)
  108.  Snail-Mail :  Tom De Voeght
  109.                Kempenlandstraat 23
  110.                2660 HOBOKEN
  111.                BELGIUM - Europe
  112.  E-Mail : tdv@suntew.ruca.ua.ac.be
  113.           tvoeght@nyx.cs.du.edu
  114. If possible, send me a note if you decide to test this program ; I'd
  115. like to hear from you guys !!!
  116. @endnode
  117. @node history "History"
  118. History :
  119. ~~~~~~~~~
  120.  v0.5 : No big deal ; it was just an ordinary 'reset'-command.
  121.  v0.7 : ReqTools-interface written.
  122.  v0.9 : STAT-RAM support included.
  123.  v1.0 : [FIRST PUBLIC RELEASE] - Should work fine now.
  124. @endnode
  125.                    
  126. @node todo "To Do"
  127. TO DO :
  128. ~~~~~~~
  129. For the moment, it's a rather small and simple command. It's easy coding,
  130. and no fancy stuff imbedded. But of course I have some dreams :
  131.  - Command line options.
  132.  - Disable/Enable ReqTools Switch.
  133.  - Direct rebooting (no acknowledgements)
  134.  - Variable wait-periods before the actual ShutDown.
  135.  - Anything else ? (tell me !)
  136.  - Smaller code. (I still find 1.5 Kb rather large, but I'm a perfectionist)
  137. @endnode
  138. @node reqtools "ReqTools"
  139. ReqTools :
  140. ~~~~~~~~~~
  141. This is the name of an excellent library, offering you the best looking
  142. requesters under all OS's. If you've never heared of it, check it out
  143. right NOW !!!
  144.    -> ReqTools is Copyright (c) Nico Fran
  145. ois. <-
  146. Thanks, Nico, for such a great library, and of course thanks for making
  147. it available to the public !!!
  148. @endnode
  149.